<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>anchoredviewportposition.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
  </script>

  <script src="static/js/doc.js">
  </script>

  <meta charset="utf8">
</head>

<body onload="prettyPrint()">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_positioning_anchoredviewportposition.js.html">anchoredviewportposition.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line2"></a>// you may not use this file except in compliance with the License.
<a name="line3"></a>// You may obtain a copy of the License at
<a name="line4"></a>//
<a name="line5"></a>//     http://www.apache.org/licenses/LICENSE-2.0
<a name="line6"></a>//
<a name="line7"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line8"></a>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
<a name="line9"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line10"></a>// See the License for the specific language governing permissions and
<a name="line11"></a>// limitations under the License.
<a name="line12"></a>
<a name="line13"></a>// Copyright 2006 Google Inc. All Rights Reserved.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview Anchored viewport positioning class.
<a name="line17"></a> *
<a name="line18"></a> */
<a name="line19"></a>
<a name="line20"></a>goog.provide(&#39;goog.positioning.AnchoredViewportPosition&#39;);
<a name="line21"></a>
<a name="line22"></a>goog.require(&#39;goog.math.Box&#39;);
<a name="line23"></a>goog.require(&#39;goog.math.Coordinate&#39;);
<a name="line24"></a>goog.require(&#39;goog.positioning&#39;);
<a name="line25"></a>goog.require(&#39;goog.positioning.AnchoredPosition&#39;);
<a name="line26"></a>goog.require(&#39;goog.positioning.Corner&#39;);
<a name="line27"></a>goog.require(&#39;goog.positioning.CornerBit&#39;);
<a name="line28"></a>goog.require(&#39;goog.positioning.Overflow&#39;);
<a name="line29"></a>goog.require(&#39;goog.positioning.OverflowStatus&#39;);
<a name="line30"></a>
<a name="line31"></a>
<a name="line32"></a>/**
<a name="line33"></a> * Encapsulates a popup position where the popup is anchored at a corner of
<a name="line34"></a> * an element. The corners are swapped if dictated by the viewport. For instance
<a name="line35"></a> * if a popup is anchored with it&#39;s top left corner to the bottom left corner of
<a name="line36"></a> * the anchor the popup is either displayed below the anchor (as specified) or
<a name="line37"></a> * above it if there&#39;s not enough room to display it below.
<a name="line38"></a> *
<a name="line39"></a> * When using this positioning object it&#39;s recommended that the movable element
<a name="line40"></a> * be absolutely positioned.
<a name="line41"></a> *
<a name="line42"></a> * @param {Element} anchorElement Element the movable element should be
<a name="line43"></a> *     anchored against.
<a name="line44"></a> * @param {goog.positioning.Corner} corner Corner of anchored element the
<a name="line45"></a> *     movable element should be positioned at.
<a name="line46"></a> * @param {boolean} opt_adjust Whether the positioning should be adjusted until
<a name="line47"></a> *    the element fits inside the viewport even if that means that the anchored
<a name="line48"></a> *    corners are ignored.
<a name="line49"></a> * @constructor
<a name="line50"></a> * @extends {goog.positioning.AnchoredPosition}
<a name="line51"></a> */
<a name="line52"></a>goog.positioning.AnchoredViewportPosition = function(anchorElement,
<a name="line53"></a>                                                     corner,
<a name="line54"></a>                                                     opt_adjust) {
<a name="line55"></a>  goog.positioning.AnchoredPosition.call(this, anchorElement, corner);
<a name="line56"></a>
<a name="line57"></a>  /**
<a name="line58"></a>   * Whether the positioning should be adjusted until the element fits inside
<a name="line59"></a>   * the viewport even if that means that the anchored corners are ignored.
<a name="line60"></a>   * @type {boolean|undefined}
<a name="line61"></a>   * @private
<a name="line62"></a>   */
<a name="line63"></a>  this.adjust_ = opt_adjust;
<a name="line64"></a>};
<a name="line65"></a>goog.inherits(goog.positioning.AnchoredViewportPosition,
<a name="line66"></a>              goog.positioning.AnchoredPosition);
<a name="line67"></a>
<a name="line68"></a>
<a name="line69"></a>/**
<a name="line70"></a> * Repositions the movable element.
<a name="line71"></a> *
<a name="line72"></a> * @param {Element} movableElement Element to position.
<a name="line73"></a> * @param {goog.positioning.Corner} movableCorner Corner of the movable element
<a name="line74"></a> *     that should be positioned adjacent to the anchored element.
<a name="line75"></a> * @param {goog.math.Box} opt_margin A margin specified in pixels.
<a name="line76"></a> * @param {goog.math.Size} opt_preferredSize The preferred size of the
<a name="line77"></a> *     movableElement.
<a name="line78"></a> */
<a name="line79"></a>goog.positioning.AnchoredViewportPosition.prototype.reposition = function(
<a name="line80"></a>    movableElement, movableCorner, opt_margin, opt_preferredSize) {
<a name="line81"></a>  // TODO: Rewrite retry logic to use the positioning status code.
<a name="line82"></a>  var status = goog.positioning.positionAtAnchor(this.element, this.corner,
<a name="line83"></a>      movableElement, movableCorner, null, opt_margin,
<a name="line84"></a>      goog.positioning.Overflow.FAIL_X | goog.positioning.Overflow.FAIL_Y,
<a name="line85"></a>      opt_preferredSize) &amp; goog.positioning.OverflowStatus.FAILED;
<a name="line86"></a>
<a name="line87"></a>  // If the desired position is outside the viewport swap the specified corners
<a name="line88"></a>  // to display it on the other side (above rather than below, to the left
<a name="line89"></a>  // rather then to the right and so on) of the anchor element.
<a name="line90"></a>  if (status) {
<a name="line91"></a>    status = goog.positioning.positionAtAnchor(this.element, movableCorner,
<a name="line92"></a>        movableElement, this.corner, null, opt_margin,
<a name="line93"></a>        goog.positioning.Overflow.FAIL_X | goog.positioning.Overflow.FAIL_Y,
<a name="line94"></a>        opt_preferredSize) &amp; goog.positioning.OverflowStatus.FAILED;
<a name="line95"></a>
<a name="line96"></a>    if (status) {
<a name="line97"></a>      // If that also fails adjust the position until it fits.
<a name="line98"></a>      if (this.adjust_) {
<a name="line99"></a>        goog.positioning.positionAtAnchor(this.element, this.corner,
<a name="line100"></a>            movableElement, movableCorner, null, opt_margin,
<a name="line101"></a>            goog.positioning.Overflow.ADJUST_X |
<a name="line102"></a>            goog.positioning.Overflow.ADJUST_Y, opt_preferredSize);
<a name="line103"></a>
<a name="line104"></a>      // Or display it anyway at the prefered position, if the adjust option was
<a name="line105"></a>      // not enabled.
<a name="line106"></a>      } else {
<a name="line107"></a>        goog.positioning.positionAtAnchor(this.element, this.corner,
<a name="line108"></a>            movableElement, movableCorner, null, opt_margin,
<a name="line109"></a>            goog.positioning.Overflow.IGNORE, opt_preferredSize);
<a name="line110"></a>      }
<a name="line111"></a>    }
<a name="line112"></a>  }
<a name="line113"></a>};
</pre>


</body>
</html>
